Where Is It? - Description API 2.20

Programmer's Reference

Welcome to the WhereIsIt's Description Application Programming Interface (Description API, or DescAPI), a special feature available to programmers to extend WhereIsIt's capabilities with automatic description importing. For all those new to programming, API is a standardized set of functions and procedures that allow both master program and extension library to communicate. With Description API, your end result will be a DLL library implementing functions described here, therefor allowing itself to integrate in WhereIsIt application.

This document covers both DescAPI 1.0, used in WhereIsIt 2.xx, as well as newer DescAPI 2.xx, used in WhereIsIt 3.xx.

DescAPI versions

DescAPI 1.0
The original DescAPI interface, first introduced in WhereIsIt 2.00 and supporting plugins for importing description information. Plugins written using DescAPI 1.00 can be used in all WhereIsIt 2.00 and later versions.

DescAPI 2.0
A major upgrade to the original DescAPI 1.00, introducing thumbnail plugins, formatting plugins, CDDB plugins, and alias names, among others. DescAPI 2.0 is supported in WhereIsIt 3.00 and newer - DescAPI 2.0 is backward compatible with DescAPI 1.0 (old plugins work with DescAPI 2.0, too), however plugins written using DescAPI 2.0 can not be used in older WhereIsIt 2.xx releases.

DescAPI 2.10
Introduced in WhereIsIt 3.20. Adds support for file name formatting and custom icons plugins. Plugins written for DescAPI 2.10 can be used in all WhereIsIt 3.xx and newer versions, however in older WhereIsIt 3.0x and 3.1x both new plugin types will not be available.

DescAPI 2.20
Supported by WhereIsIt 3.50 and later. The main new feature in this version is the introduction of runtime plugins.